Mention educational value of short checklist #610
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for i18n-drafts ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
aphillips
approved these changes
Nov 14, 2024
| @@ -104,7 +104,7 @@ <h2 class="notoc" style="hyphens:none;">Create a report</h2> | |||
| Comments go here. | |||
| - [ ] Not applicable | |||
|
|
|||
| 9. [ ] _If the spec (or its implementation) defines markup_ **ensure support for internationalization features and avoid putting human-readable text in attribute values or plain-text elements**. Also check the detailed guidance for [Markup & syntax](https://www.w3.org/TR/international-specs/#markup). | |||
| 9. [ ] _If the spec (or its implementation) defines markup_ **ensure support for internationalisation features and avoid putting human-readable text in attribute values or plain-text elements**. Also check the detailed guidance for [Markup & syntax](https://www.w3.org/TR/international-specs/#markup). | |||
There was a problem hiding this comment.
Really? Zpelling change? 😉
| <p>This page points developers of specifications to various aspects of their spec that may need internationalization review. It can also be used by spec reviewers, to get an idea of what to look for in a spec.</p> | ||
| <p><strong>You should raise an issue in your own repository to show the answers to these questions, and attach the i18n-tracker label so that we are notified. Under 'Create a Report' you'll find a way to create a report.</strong></p> | ||
| <p><strong>The primary purpose for this page is educational. It helps you to learn about internationalization features that may affect the design of your spec. You should read it <em>and</em> <a href="https://www.w3.org/TR/international-specs/">Internationalization Best Practices for Spec Developers</a> as early as possible, so that you are aware of what your spec will need to address. Then, to ensure that you haven't missed anything, you can also use this page as a checklist prior to publishing the spec as a FPWD.</strong></p> | ||
| <p>You should raise an issue in your own repository to show the answers to these questions, and attach the i18n-tracker label so that we are notified. Under 'Create a Report' you'll find a way to create a report.</p> |
There was a problem hiding this comment.
put <code> around i18n-tracker?
| @@ -141,8 +141,8 @@ <h2 class="notoc">Useful links</h2> | |||
|
|
|||
|
|
|||
| <section> | |||
| <p>This page points developers of specifications to various aspects of their spec that may need internationalization review. It can also be used by spec reviewers, to get an idea of what to look for in a spec.</p> | |||
| <p><strong>You should raise an issue in your own repository to show the answers to these questions, and attach the i18n-tracker label so that we are notified. Under 'Create a Report' you'll find a way to create a report.</strong></p> | |||
| <p><strong>The primary purpose for this page is educational. It helps you to learn about internationalization features that may affect the design of your spec. You should read it <em>and</em> <a href="https://www.w3.org/TR/international-specs/">Internationalization Best Practices for Spec Developers</a> as early as possible, so that you are aware of what your spec will need to address. Then, to ensure that you haven't missed anything, you can also use this page as a checklist prior to publishing the spec as a FPWD.</strong></p> | |||
There was a problem hiding this comment.
I like this a lot.
Consider using a class with a style instead of just using <strong>. We want people to read this and maybe a different background or other handling will help make it visible.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.